home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 51 / Amiga Format CD51 (2000-03-10)(Future Publishing)(GB)[!][issue 2000-04].iso / -in_the_mag- / pdselect / awnp / awnp-docs / getfile.doc < prev    next >
Text File  |  2000-02-16  |  5KB  |  231 lines
  1. There are actualy two file requesters available in AWNPipe. The ClassAct/Reation getfile.gadget, and the ASL file requester. Only the getfile.gadget can be displayed in a gui. Both can be opened under your control to present the user with a file requester. The details for the ASL requester are at the end of this file.
  2.  
  3.   *** GETFILE GADGET CLASS ***
  4.  
  5. GetFile gadget event.
  6. -------------------------
  7.  
  8. 'gadget GID  success ["filename" ["filename" ...]]'
  9.  
  10.  Success=0 user selected no file or canceled.
  11.  Success!=0 user selected a file.
  12. Filenames are fully qualified with path.
  13.  
  14. GetFile gadget parameters.
  15. -------------------------
  16.  
  17. font=GID
  18.  
  19. This sets the font for the gadget. The GID points to an ALREADY defined text attribute.
  20.  
  21.  
  22. readonly (ro)
  23.  
  24.  This gadget is read only.
  25.  
  26. disable=number (dis=)
  27.  
  28.  The gadget is disabled if number = 0 , enabled if number != 0. Defaults to enabled.
  29.  
  30. gadgettext="file requester title" (gt=)
  31.  
  32.  Set the title of the file requester.
  33.  
  34. pattern="pattern" (pat=)
  35.  
  36.  Set and Enable pattern matching in the file.
  37.  
  38. multi  (m)
  39.  
  40.  Allow multi selection in the file requester. (does not seem to work)
  41.  
  42. save
  43.  
  44.  This is a save requester.
  45.  
  46. drawers (dr)
  47.  
  48.  Only show and allow selections of drawers.
  49.  
  50. icons (i)
  51.  
  52.  Do NOT show .info files.
  53.  
  54. filename="path:filename" (fn=)
  55.  
  56.  Set the filename and directory for the file requester. It must end in a '/' for drawer only file requesters
  57.  
  58. Wide=num
  59. High=num
  60.  
  61.  Set the size of the requester when opened.
  62.  
  63. unattached    (ua)
  64.  
  65.  This file requester is not attached to the CA window. It may still be activated in the modify conversation.
  66.  
  67. minwidth=number (minw=)
  68.  
  69.  Set the minimum width for this gadget
  70.  
  71. minheight=number (minh=)
  72.  
  73.  Set the minimum height for this gadget
  74.  
  75. weightedwidth=number (weiw=)
  76.  
  77.  Set the weighted width for this gadget
  78.  
  79. weightedheight=number (weih=)
  80.  
  81.  Set the weighted height for this gadget
  82.  
  83. nominalsize (noms)
  84.  
  85.  Set this gadget to its nominal size.
  86.  
  87. tags="tags|data[|tag|data...]|0
  88.  
  89.  A list of tag and value pairs in HEX. Do not forget the trailing null !
  90.  
  91. childlabel    (chl)
  92. childlabelr   (chlr)
  93.  
  94.  Use the previously defined image as a childlabel for this gadget. Display the childlabel to the right or left of the gadget.
  95.  
  96. replace=GID
  97.  
  98.  Use this gadget to replace an existing gadget specified by GID.
  99.  
  100. Definition Reply
  101. -----------------
  102.  
  103.  When the gadget creation is successful the pipe replies
  104. with
  105.  
  106. 'ok GID'
  107.  
  108. GetFile gadget modify parameters.
  109. -------------------------
  110.  
  111. selected=number (sel=)
  112.  
  113. Number is ignored but must be given. This opens the file requester and the selected files are returned rather than a simple ok.
  114. THIS ONLY WORKS FOR UNATTACHED GETFILE GADGETS.
  115.  
  116. disable=number (dis=)
  117.  
  118.  The gadget is disabled if number = 0 , enabled if number != 0.
  119.  
  120. save=number
  121.  
  122.  If number=0 this is NOT a save requester. If number~=0 this is a save requester.
  123.  
  124. filename="path:filename" (fn=)
  125.  
  126.  Set the filename and directory for the file requester.
  127.  
  128. gadgettext="title" (gt=)
  129.  
  130.  Set the file requesters title.
  131.  
  132.  
  133.   *** GETFILE ASL ***
  134.  
  135. The ASL requester does not send events.
  136.  
  137. GetFile ASL parameters.
  138. -------------------------
  139.  
  140. ASL
  141.  
  142.   This tells AWNP you want to define an ASL file requester.
  143.  
  144. font=GID
  145.  
  146. This sets the font for the gadget. The GID points to an ALREADY defined text attribute.
  147.  
  148.  
  149. gadgettext="file requester title" (gt=)
  150.  
  151.  Set the title of the file requester.
  152.  
  153. pattern="pattern" (pat=)
  154.  
  155.  Set and Enable pattern matching in the file.
  156.  
  157. multi  (m)
  158.  
  159.  Allow multi selection in the file requester. (does not seem to work)
  160.  
  161. save
  162.  
  163.  This is a save requester.
  164.  
  165. drawers (dr)
  166.  
  167.  Only show and allow selections of drawers.
  168.  
  169. icons (i)
  170.  
  171.  Do NOT show .info files.
  172.  
  173. filename="path:filename" (fn=)
  174.  
  175.  Set the filename and directory for the file requester. It must end in a '/' for drawer only file requesters
  176.  
  177. Wide=num
  178. High=num
  179.  
  180.  Set the size of the requester when opened.
  181.  
  182. top=num
  183. left=num
  184.  
  185.  Set the position of the requester when it opens.
  186.  
  187.  
  188. Definition Reply
  189. -----------------
  190.  
  191.  When the gadget creation is successful the pipe replies
  192. with
  193.  
  194. 'ok GID'
  195.  
  196. GetFile ASL modify parameters.
  197. -------------------------
  198.  
  199. selected=number (sel=)
  200.  
  201. Number is ignored but must be given. This opens the file requester and you get returned the following line rather than a simple ok.
  202.  
  203. SUCCESS "path:drawer/filename" "path2:drawer2/filename2"  ...
  204.  
  205. SUCCESS =1 if the user selected a file, SUCCESS=0 if the user aborted the file requester without making a selection. Each file name is quoted and all are on a single line.
  206.  
  207.  
  208. save=number
  209.  
  210.  If number=0 this is NOT a save requester. If number~=0 this is a save requester.
  211.  
  212. filename="path:filename" (fn=)
  213.  
  214.  Set the filename and directory for the file requester.
  215.  
  216. gadgettext="title" (gt=)
  217.  
  218.  Set the file requesters title.
  219.  
  220. Wide=num
  221. High=num
  222.  
  223.  Set the size of the requester when opened.
  224.  
  225. top=num
  226. left=num
  227.  
  228.  Set the position of the requester when it opens.
  229.  
  230.  
  231.